home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / batchut / batmnu21.zip / BATMNU21.DOC < prev    next >
Text File  |  1992-07-11  |  23KB  |  608 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                   ┌─────────────────────────────────────┐  
  20.                   │  ╔═══════════════════════════════╗  │▒▒
  21.                   │  ║                               ║  │▒▒
  22.                   │  ║           BATMNU.EXE          ║  │▒▒
  23.                   │  ║     Batch File Menu System    ║  │▒▒
  24.                   │  ║          Version  2.1         ║  │▒▒
  25.                   │  ║                               ║  │▒▒
  26.                   │  ╚═══════════════════════════════╝  │▒▒
  27.                   └─────────────────────────────────────┘▒▒
  28.                     ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.                                  July 11, 1992
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.                               TABLE OF CONTENTS
  81.  
  82. INTRODUCTION  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .    1
  83.      Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .    1
  84.  
  85. MENU FORMAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .    1
  86.      General Format Rules . . . . . . . . . . . . . . . . . . . . . . . .    1
  87.      Window Options . . . . . . . . . . . . . . . . . . . . . . . . . . .    2
  88.      Color Values . . . . . . . . . . . . . . . . . . . . . . . . . . . .    2
  89.      Window Appearance  . . . . . . . . . . . . . . . . . . . . . . . . .    3
  90.      Option Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . .    3
  91.      Option Help  . . . . . . . . . . . . . . . . . . . . . . . . . . . .    4
  92.      Headers and Footers  . . . . . . . . . . . . . . . . . . . . . . . .    4
  93.  
  94. WHAT HAPPENS IN THE BATCH FILE? . . . . . . . . . . . . . . . . . . . . .    4
  95.  
  96. MENUS WITH PARAMETERS . . . . . . . . . . . . . . . . . . . . . . . . . .    5
  97.  
  98. MOUSE SUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .    7
  99.  
  100. SHAREWARE INFORMATION . . . . . . . . . . . . . . . . . . . . . . . . . .    7
  101.  
  102. BATMNU.EXE History  . . . . . . . . . . . . . . . . . . . . . . . . . . .    8
  103.  
  104.  
  105.  
  106.  
  107.                                   BATMNU.EXE
  108.                                  Warren Small
  109.                                    (c) 1992
  110.  
  111.                                  INTRODUCTION
  112.  
  113. This  program is a  menuing system for use  with your batch files.   It is not
  114. intended  to  be  a  shell,  although with  some  very  ambitious  batch  file
  115. programming, it could be used as one. Its  purpose is to provide sophisticated
  116. flow control  and give  batch files  a professional  appearance by  creating a
  117. point-and-shoot menu with up to 26  options per menu. The cursor  keys and the
  118. HOME  and END keys can then be used to make the  selection. Each option can be
  119. selected  by a  'hotkey' defined  by your menu.  A mouse is  also supported if
  120. detected. 
  121.  
  122.              Syntax: BATMNU [d:][path]filename [label] [default]
  123.  
  124. The program  defaults to  an  extension of  "mnu"  if  none is  provided.  The
  125. filename  can be a separate file or, if you prefer, the menu can be within the
  126. calling batch file.  You will have to code the  batch file so those lines  are
  127. never executed,  of course.  If a  separate file is  used, it can  be 'hidden'
  128. making it more secure from tapering. 
  129.  
  130. The optional  label parameter  can be used  if you wish  to put more  than one
  131. menu within the  file. Bracket your menu lines with ":label" and ":end_label".
  132. BATMNU  will  search  your  path for  the  file  if it's  not  in  the current
  133. directory. The label can be up to 15 characters long. 
  134.  
  135. The default parameter on the command line is  used if you want an option other
  136. than  the first  one to  be highlighted  when  the  menu starts.  e.g. "BATMNU
  137. NORTON.BAT 3" will highlight the third option.
  138.  
  139.                                  MENU FORMAT
  140.  
  141.      :menu  {keyword to mark where the program should start reading}
  142.      header,header text
  143.      h_format,fYEL,bred,t1,d1  {header colors, time, date}
  144.      window,tRED,hWHI,...   {colors and window appearance definition}
  145.      title,title text
  146.      option,option text,[#] {# indicates hotkey position in option text}
  147.      help,help text       {must follow option help refers to}
  148.      option,option text,[#][,[drive],[directory],program] {optional format}
  149.      option...
  150.      . 
  151.      .
  152.      .
  153.      footer,footer text
  154.      f_format,fYEL,bred,t1,d1  {footer colors, time, date}
  155.      :end_menu  {Program stops reading and closes the file}
  156.  
  157.                            - General Format Rules -
  158.  
  159. The  definition can be organized in  almost any order  as long as it is placed
  160. between the  ':menu' and ':end_menu' keywords  (or other label  if provided on
  161. the  command line). The  window line  should appear before the  options if you
  162. use the  'l', 'n'  or 'a' parameter.  Maximum title length  is 55  characters.
  163.  
  164.                                  Page 1 of 8
  165.                                    Ver. 2.1
  166.  
  167.  
  168.  
  169.  
  170.                                   BATMNU.EXE
  171.                                  Warren Small
  172.                                    (c) 1992
  173.  
  174. Headers and footers can be 70 characters long if the  time and/or date are not
  175. used. If you leave  the title out,  your menu  will contain only your  defined
  176. options.  Header  and  footer  are  optional.  Maximum  option  length  is  50
  177. characters for  single  column menus  and  25  characters for  double  column.
  178. Maximum help length is 70 characters.
  179.  
  180. All parameters on the  window, h_format and f_format lines are separated by  a
  181. comma.  Spaces are  ignored. The  keywords  can be  indented for  clarity,  if
  182. desired, using spaces or TABs.
  183.  
  184.                               - Window Options -
  185.  
  186. The "window"  line in your menu will define the colors  and appearance of your
  187. menu. The color options are:
  188.  
  189.      f - foreground color of window (0-15)
  190.      b - background color of window, (0-7)
  191.      t - title color (0-15)
  192.      o - option color (0-15)
  193.      h - hotkey color (0-15)
  194.      k - screen color (clears screen), foreground (0-15) & background (0-7)
  195.      e - screen border color (0-15)
  196.  
  197. Color options  should be  followed by  one of the  color values  shown in  the
  198. chart below.  Hotkeys can  be made  invisible by  using "hinv"  on the  window
  199. line.  The hotkeys  will  still select  the  options  but  the menu  will  not
  200. indicate them. This gives you the look of a simpler "light bar" style menu. 
  201.  
  202.                                - Color Values -
  203.  
  204.                0 or bla = Black      8 or BLA = Grey          
  205.                1 or blu = Blue       9 or BLU = Bright Blue   
  206.                2 or gre = Green     10 or GRE = Bright Green  
  207.                3 or cya = Cyan      11 or CYA = Bright Cyan   
  208.                4 or red = Red       12 or RED = Bright Red    
  209.                5 or mag = Magenta   13 or MAG = Bright Magenta
  210.                6 or yel = Brown     14 or YEL = Yellow        
  211.                7 or whi = White     15 or WHI = Bright White  
  212.  
  213. The  'k' option fills double duty setting the  foreground and background color
  214. for the screen. The first k parameter  will set the background, the second the
  215. foreground  (Foreground default is  "whi" if  not specified).   The foreground
  216. color is  used with the fill  character. The fill  character can appear  after
  217. the color of either  to give the screen background  more interest than  a flat
  218. color. Use of the drop shadow is more dramatic too.
  219.  
  220. If  you prefer, a string could  be used to fill the  screen background. Either
  221. words or special  characters could be used. Put  the string after the color as
  222. above. If you  want to add spaces, use  the underscore (_)  character. It will
  223. be treated as a space when displayed. (e.g. kred_Main_Menu)
  224.  
  225.  
  226.  
  227.                                  Page 2 of 8
  228.                                    Ver. 2.1
  229.  
  230.  
  231.  
  232.  
  233.                                   BATMNU.EXE
  234.                                  Warren Small
  235.                                    (c) 1992
  236.  
  237. The 'e'  option sets the screen border  color which is outside the normal text
  238. area. An 'e' used alone will reset the border to its normal black.
  239.  
  240. Default colors  are provided  (fYEL, bblu, tWHI,  oCYA, hRE